package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpEducationAddDTO;
import org.jsola.hr.dto.EmpEducationUpdateDTO;
import org.jsola.hr.query.EmpEducationQuery;
import org.jsola.hr.vo.EmpEducationListVO;
import org.jsola.hr.vo.EmpEducationVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工教育经历")
public interface IEmpEducationControllerAPI {

    /**
     * 新增员工教育经历
     * @param empEducationAddDTO 员工教育经历新增实体
     * @return 员工教育经历展示对象
     */
    @ApiOperation(value = "新增员工教育经历")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationAddDTO", dataType = "EmpEducationAddDTO", value = "新增员工教育经历", paramType = "body")
    })
    Result<EmpEducationVO> save(EmpEducationAddDTO empEducationAddDTO);


    /**
     * 修改员工教育经历
     * @param empEducationUpdateDTO 员工教育经历
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工教育经历")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationUpdateDTO", dataType = "EmpEducationUpdateDTO", value = "修改员工教育经历", paramType = "body")
    })
    Result<Integer> update(EmpEducationUpdateDTO empEducationUpdateDTO);




    /**
     * 删除单个员工教育经历，彻底删除
     * @param empEducationId 员工教育经历id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工教育经历，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationId", dataType = "String", value = "员工教育经历id", paramType = "path")
    })
    Result<Integer> delete(String empEducationId);


    /**
     * 批量删除员工教育经历，彻底删除
     * @param empEducationIds 员工教育经历id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工教育经历，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationIds", dataType = "String[]", value = "员工教育经历id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empEducationIds);


    /**
     * 根据员工教育经历id查询员工教育经历详情
     * @param empEducationId 员工教育经历id
     * @return 员工教育经历详情
     */
    @ApiOperation(value="根据员工教育经历id查询员工教育经历详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationId", dataType = "String", value = "员工教育经历id", paramType = "path")
    })
    Result<EmpEducationVO> findById(String empEducationId);


    /**
     * 查询员工教育经历
     * @param empEducationQuery 员工教育经历查询参数
     * @return page
     */
    @ApiOperation(value="查询员工教育经历")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationQuery", dataType = "EmpEducationQuery", value = "员工教育经历查询参数", paramType = "query")
    })
    Result<List<EmpEducationListVO>> listAll(EmpEducationQuery empEducationQuery);


     /**
     * 分页查询员工教育经历
     * @param empEducationQuery 员工教育经历查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工教育经历")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationQuery", dataType = "EmpEducationQuery", value = "员工教育经历查询参数", paramType = "query")
    })
    Result<Page<EmpEducationListVO>> page(EmpEducationQuery empEducationQuery);

    /**
     * 删除员工教育经历
     * @param empEducationId 员工教育经历id
     * @return 删除数量
     */
    @ApiOperation(value="删除员工教育经历")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationId", dataType = "String", value = "员工教育经历id", paramType = "path")
    })
    Result<Integer> deleteEmpEducation(String empEducationId);


}

